VoicePlanウェブサービス

VoiceCheckはVoicePlanを作成することのできるWebサービスを提供します（データインポート）。このWebサービスでは、VoicePlanの作成や、VoiceCheckサーバにある既存のVoicePlanの更新や削除ができます。このWebサービスを起動すると、VoiceCheckは以下の点についてシステムを検証します：

一致するVoicePlan名がなければ、新しいVoicePlanが作成されます。
一致するVoicePlan名があれば、新しいVoicePlanは作成されません。
Description、VoiceForm、Section Stepsを含まないVoicePlanは無効と見なされ作成されません。
VoicePlanに関連付けられたVoiceFormがVoiceCheckに見つからないときにはVoicePlanは作成されません。

VoiceCheckがVoicePlanの読み取り、更新、削除のメッセージを受け取るとき、次の条件が適用されます：

VoicePlanがVoiceCheckに存在しなければ、詳細は応答に返されません。
VoicePlanが存在する場合、WebサービスはVoicePlanの名前だけを更新できます。
VoicePlanはVoiceCheck内のエンティティを参照していても削除できます。

VoicePlan作成の詳細

REST Web サービス

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan

メソッド: POST

コンテンツタイプ: application/json;charset=UTF-8

メッセージ本文: WADLのスキーマで定められた通りのJSON。要素は入力要素テーブルに記載されています。

応答: 成功の場合、HTTP Status 200 、ペイロードは“VoicePlan saved”。失敗すると、システムはエラーを返します。 200または204以外のHTTPステータスコードはエラーと見なされます。可能な場合、ホストシステムはエラーに対して本文を返します。

POST パラメータ

本文に有効なパラメータを含むVoicePlanファイル。

VoicePlan読み取りの詳細

REST WEB SERVICE

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

メソッド: GET

コンテンツタイプ: application/json;charset=UTF-8

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

VoicePlan更新の詳細

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/update/

メソッド: POST

コンテンツタイプ: application/json;charset=UTF-8

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

POST パラメータ

本文に更新されたパラメータを含むVoicePlanファイル。

VoicePlan削除の詳細

WADL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan?_wadl

URL: <http or https>://<host>:<port>/VoiceCheck/services/voiceplan/{planIdentifier}

メソッド: DELETE

応答: 成功の場合、HTTP Status 200、本文ありまたはなし。失敗すると、システムはエラーを返します。

入力要素

プロパティ	タイプ	必須	定義	検証
planIdentifier	文字列	はい	VoicePlanの名前	VoiceCheck内で一意であること